<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Call Class Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset='utf-8'>
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a name="//apple_ref/swift/Class/Call" class="dashAnchor"></a>
    <a title="Call Class Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="../index.html">ZiwoSDK 1.0.0 Docs</a> (91% documented)</p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="../index.html">ZiwoSDK Reference</a>
        <img id="carat" src="../img/carat.png" />
        Call Class Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Classes/Agent.html">Agent</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/Call.html">Call</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/RTCClient.html">RTCClient</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/VertoHelpers.html">VertoHelpers</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/VertoWebSocket.html">VertoWebSocket</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ZiwoClient.html">ZiwoClient</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ZiwoSDK.html">ZiwoSDK</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ZiwoWebSocket.html">ZiwoWebSocket</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Enums/RTCMessageType.html">RTCMessageType</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/SocketEvent.html">SocketEvent</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/VertoEvent.html">VertoEvent</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Extensions/Defaults.html">Defaults</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/Defaults/Keys.html">– Keys</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Protocols/RTCClientDelegate.html">RTCClientDelegate</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/RTCMessageBuilderProtocol.html">RTCMessageBuilderProtocol</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/RTCMessageParserProtocol.html">RTCMessageParserProtocol</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/VertoWebSocketDelegate.html">VertoWebSocketDelegate</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/ZiwoClientDelegate.html">ZiwoClientDelegate</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Structs/RTCAnswerMessage.html">RTCAnswerMessage</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/RTCCandidateMessage.html">RTCCandidateMessage</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/RTCError.html">RTCError</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/RTCMessage.html">RTCMessage</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/RTCOfferMessage.html">RTCOfferMessage</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>Call</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Call</span></code></pre>

                </div>
              </div>
            <p>Represent each call that agent will pass or receive.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC9rtcClientAA9RTCClientCvp"></a>
                    <a name="//apple_ref/swift/Property/rtcClient" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC9rtcClientAA9RTCClientCvp">rtcClient</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Instance of RTC Client. Each call has one RTC Client attached.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">internal</span> <span class="k">let</span> <span class="nv">rtcClient</span><span class="p">:</span> <span class="kt"><a href="../Classes/RTCClient.html">RTCClient</a></span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC12speakerStateSbvp"></a>
                    <a name="//apple_ref/swift/Property/speakerState" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC12speakerStateSbvp">speakerState</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Speaker state (on speaker or internal earphone).</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">internal</span> <span class="k">var</span> <span class="nv">speakerState</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC8isPausedSbvp"></a>
                    <a name="//apple_ref/swift/Property/isPaused" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC8isPausedSbvp">isPaused</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Is the call on hold state or not.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">internal</span> <span class="k">var</span> <span class="nv">isPaused</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC7isMutedSbvp"></a>
                    <a name="//apple_ref/swift/Property/isMuted" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC7isMutedSbvp">isMuted</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Is the microphone muted on this call or not.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">internal</span> <span class="k">var</span> <span class="nv">isMuted</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC6callIDSSvp"></a>
                    <a name="//apple_ref/swift/Property/callID" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC6callIDSSvp">callID</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>ID of the call</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC6sessIDSSvp"></a>
                    <a name="//apple_ref/swift/Property/sessID" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC6sessIDSSvp">sessID</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Verto session ID to which the call is linked.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">sessID</span><span class="p">:</span> <span class="kt">String</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC10callerNameSSvp"></a>
                    <a name="//apple_ref/swift/Property/callerName" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC10callerNameSSvp">callerName</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Name of the caller.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">callerName</span><span class="p">:</span> <span class="kt">String</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC13recipientNameSSvp"></a>
                    <a name="//apple_ref/swift/Property/recipientName" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC13recipientNameSSvp">recipientName</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Name of the recipient.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">recipientName</span><span class="p">:</span> <span class="kt">String</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC6callID04sessE010callerName09recipientH0ACSS_S3Stcfc"></a>
                    <a name="//apple_ref/swift/Method/init(callID:sessID:callerName:recipientName:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC6callID04sessE010callerName09recipientH0ACSS_S3Stcfc">init(callID:<wbr>sessID:<wbr>callerName:<wbr>recipientName:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Initializes a new call according to given informations.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">sessID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">callerName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">recipientName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call (<code><a href="../Classes/Call.html#/s:7ZiwoSDK4CallC6callIDSSvp">callID</a></code> is a UUID generated randomly during call creation).</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>sessID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The session ID of the logged agent. This value is stored in <code><a href="../Classes/VertoWebSocket.html">VertoWebSocket</a></code> class.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>callerName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Name of the caller.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>recipientName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Name of the recipient.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A Ziwo call object.</p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC20setMicrophoneEnabledyySbF"></a>
                    <a name="//apple_ref/swift/Method/setMicrophoneEnabled(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC20setMicrophoneEnabledyySbF">setMicrophoneEnabled(_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Method to set activity of the microphone during a call.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">setMicrophoneEnabled</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>value</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Boolean that defines the microphone activity.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC12setSpeakerOnyyF"></a>
                    <a name="//apple_ref/swift/Method/setSpeakerOn()" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC12setSpeakerOnyyF">setSpeakerOn()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Switch the audio call on speaker.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">setSpeakerOn</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK4CallC13setSpeakerOffyyF"></a>
                    <a name="//apple_ref/swift/Method/setSpeakerOff()" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK4CallC13setSpeakerOffyyF">setSpeakerOff()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Switch the audio call on internal speaker.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">setSpeakerOff</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2020 <a class="link" href="https://github.com/ASWATFZLLC/ziwo-sdk-ios" target="_blank" rel="external">Emilien Roussel</a>. All rights reserved. (Last updated: 2020-05-14)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
